Skip to content

[Browser Run] Add REST API browser session to get-started#32085

Open
kathayl wants to merge 1 commit into
productionfrom
kliao/browser-run-get-started-sessions
Open

[Browser Run] Add REST API browser session to get-started#32085
kathayl wants to merge 1 commit into
productionfrom
kliao/browser-run-get-started-sessions

Conversation

@kathayl

@kathayl kathayl commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a REST API tab to the Browser Sessions section of the get-started page. Previously, the only get-started path for browser sessions was a 7-step Workers binding example (create project, install Puppeteer, create KV, configure wrangler, write code, test, deploy). This adds a simpler entry point: one curl to create a session, open the devtoolsFrontendUrl in your browser, and you have a live browser session.

Changes

  • Adds REST API / Workers binding tabs to the Browser Sessions section (matching the pattern already used in Quick Actions)
  • REST API tab: single curl example, trimmed response highlighting devtoolsFrontendUrl, and a brief explanation of what to do with it
  • Links out to Live View, Session Recording, and Human in the Loop features
  • Links out to CDP, Puppeteer, and Playwright docs for programmatic control
  • Existing Workers binding example is unchanged, just moved into a tab

Review checklist

  • Only one file changed (src/content/docs/browser-run/get-started.mdx)
  • pnpm run check passes (0 errors)
  • Formatting unchanged (already formatted)
  • Previewed locally

@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Review

💡 2 suggestions found in commit 14da094.

Fix in your agent
Fix the following review findings in PR #32085 (https://github.com/cloudflare/cloudflare-docs/pull/32085).

Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
  or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order

After triaging, fix all legitimate findings. For any you decide to skip,
post a comment on this PR with the finding ID and your reasoning.

---

## Style Guide Review

### Suggestions (2)

#### SG-924c75d53f48 · Use APIRequest for Cloudflare API endpoints
- **File:** `src/content/docs/browser-run/get-started.mdx` line 68
- **Issue:** Line adds <CURL> with url="https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/browser-rendering/devtools/browser" documenting a Cloudflare API endpoint
- **Fix:** Use <APIRequest> instead of <CURL> for Cloudflare API endpoints

#### SG-df5524e17ee1 · Use select instead of click
- **File:** `src/content/docs/browser-run/get-started.mdx` line 91
- **Issue:** Line adds "click around" in prose
- **Fix:** Reword to avoid click (for example, "interact with the page" or "navigate the page")

Code Review

This code review is in beta and may not always be helpful — use your judgment.

No code review issues found.

Conventions

No convention issues found.

Style Guide Review

Suggestions (2)
File Issue
browser-run/get-started.mdx line 68 Use APIRequest for Cloudflare API endpoints — Line adds with url="https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/browser-rendering/devtools/browser" documenting a Cloudflare API endpoint Fix: Use instead of for Cloudflare API endpoints
browser-run/get-started.mdx line 91 Use select instead of click — Line adds "click around" in prose Fix: Reword to avoid click (for example, "interact with the page" or "navigate the page")
Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/browser-run/ @mchenco, @cloudflare/product-owners, @celso, @kathayl, @dcpena, @meddulla, @simonabadoiu, @jonnyparris, @ruifigueira, @Refaerds, @omarmosid

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor


### Create a browser session

A single API call gives you a live browser session you can see and interact with:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the product!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants